home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / utmisc1 / xpkrchvp.lha / XpkArchivePackage / XArcTool.doc < prev    next >
Text File  |  1996-05-07  |  10KB  |  269 lines
  1.  
  2.  
  3.                             XArcTool V2.0
  4.                             =============
  5.  
  6.                        © 1995 by Matthias Meixner
  7.  
  8.  
  9.  
  10.                             Introduction
  11.                             ------------
  12. XArctool is a graphical userinterface for the xpkarchive.library. It allows
  13. you to handle archives similar to directory-utilities like opus. You can
  14. add files to archives, extract files from them and copy files between
  15. different archives without decompression/compression. Furthermore it allows
  16. you to copy files from one directory to another just like a normal
  17. directory-utility. What's new is the ability to rename files within archives
  18. and add filenotes to files within an archive. You can modify the
  19. protectionflags of files and keep track of different versions of one file
  20. within the archives. This is achieved using file-generations. If you add a
  21. file to an archive and there is already a file with the same name in it,
  22. then the new file gets the next higher version number. The higher the
  23. versionnumber is, the newer is the file (at least as long as you have not
  24. changed the versionnumber manually). Versionnumber 0 has a special meaning,
  25. it references always the file with the highest versionnumber for a given
  26. file, which is normally the newest version of that file.
  27. In fact all these abilities are offered by the xpkarchive.library and
  28. XArcTool is just a comfortable userinterface to the abilities of this
  29. library. If you want to use these functions yourself read the docs of the
  30. xpkarchive.library that comes with this package.
  31. XArcTool is fontsensitive up to a certain degree as long as the size of the
  32. font is not too large for the selected size of the window. However if you
  33. select a very large font and select very small windowdimensions the layout
  34. will get messed up, but the program still should work fine.
  35.  
  36.  
  37.                             License/Disclaimer
  38.                             ------------------
  39.  
  40. XArcTool (C) Copyright 1995 by Matthias Meixner.  All rights reserved.
  41.  
  42.  This program is GIFTWARE which means that if you like the program you
  43.  should reward the author with a gift that, you think, matches his efforts.
  44.  
  45.    This Program may be freely distributed with the XPK compression
  46.  package, as long as it is kept in its original, complete, and unmodified
  47.  form.  It may not be distributed by itself or in a commercial package of
  48.  any kind without my written permission. This also means the distribution
  49.  on cover disks, disk magazines etc. Fred Fish may include this program on
  50.  his AmigaLibDisk series.
  51.  
  52.   This program is distributed in the hope that it will be useful, but
  53. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  54. or FITNESS FOR A PARTICULAR PURPOSE.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                           Getting started
  61.                           ---------------
  62. First install the xpkarchive.library by doubleclicking on the
  63. "Install_Lib"-icon, then simply drag the whole drawer to a location on
  64. your harddisk.
  65.  
  66. CLI-USAGE:
  67.  
  68. XArcTool PATH/M,P=PACKER/K,M=MODE/N,PW=PASSWD/K,L=LEFT/N,T=TOP/N,W=WIDTH/N,
  69.          H=HEIGHT/N,I=ICON/S
  70.  
  71. Option:     Effect:
  72.  
  73. PATH/M      Allows you to select the two paths, that XArcTool uses. They may
  74.             be also archives, that should be entered.
  75.  
  76.             e.g.   XArctool ram: hd0:
  77.  
  78. P=PACKER    selects the default packer
  79.  
  80. M=MODE      selects the default packmode
  81.  
  82. PW=PASSWD   selects the default password for encryption
  83.  
  84. L=LEFT,
  85. T=TOP,
  86. W=WIDTH,
  87. H=HEIGHT    selects the position and dimensions of XArcTool's window
  88.  
  89. I=ICON      cause XArcTool to generate icons for archives.
  90.  
  91. Additional example:
  92.  
  93.        XArcTool P=FEAL M=100 PW=test ICON ram:
  94.  
  95.        Will cause XArcTool to use FEAL with mode 100 and password "test" as
  96.        default. The path of the left directorylist will be "ram:". It will
  97.        generate icons for newly generated archives.
  98.  
  99.  
  100. WB-USAGE:
  101.  
  102. WB offers the same options as available from CLI, just add one line
  103. per option in the tooltypes in the icon. You can feature the PATH
  104. option by using multiple selection from workbench: click once on XArcTool,
  105. then once on the first directory and then doubleclick the icon of the second
  106. directory. Very useful in this context are the LEFT,TOP,WIDTH and HEIGHT
  107. options which allow you to customize the size of XArcTool's window via the
  108. tooltypes.
  109.  
  110.  
  111.  
  112.  
  113.                         Using XArcTool
  114.                         --------------
  115.  
  116. When XArcTool opens up its window you will see two directorylists, one on
  117. the left and one on the right side. The stringgadgets above represent the
  118. pathname of the directories that are displayed, where the upper one gives
  119. the pathname on disk and the lower one gives you the pathname within an
  120. archive if you have selected an archive in the upper path. The arrow between
  121. the two pathgadgets defines the direction of the copy command and by this it
  122. defines the source- and destinationdirectories. All other actions refer to
  123. the sourcedirectory.
  124. Archives are handled similar to normal directories, just that additional
  125. actions will take place. That is if you copy a file from a normal directory
  126. to an archive the file will be compressed. If you copy the other way round
  127. the file will be decompressed. Copying from one archive to another will not
  128. affect the compression, it does not decompress and recompress the file and
  129. is therefore quite fast.
  130.  
  131. Creating archives or directories:
  132. If you type a path that does not exist yet, you are prompted if you want to
  133. create this object as a directory or as an archive. By this you can create
  134. new archives. Archives will get the fileextension ".xar", if they do not
  135. have already an extension. You can also use the "Makedir" or "Makearc"
  136. buttons to create a directory or an archive.
  137.  
  138. Copying/compressing/decompressing files:
  139. Select the files by clicking on the corresponding lines in the directorylist
  140. or using one of the "tag" menus and click on the gadget "Copy". Depending on
  141. the selected path/archivenames the file will be (de)compressed or just
  142. copied. You can enter directories or archives by doubleclicking on these
  143. entries in the directorylists.
  144.  
  145. Renaming of files:
  146. Select the files and click on "Rename". A requester will pop up and ask you
  147. to enter the new name and if the file resides within an archive the new
  148. generationnumber. You may rename directories as well as files.
  149. (See also information on generations)
  150.  
  151. Deleting files:
  152. "Delete" deletes the selected files, if they are within a normal directory.
  153. Files within an archive may just be marked as deleted depending of the
  154. compression-method used (and therefore depending on the archivetype).
  155. They are physically removed by using the "Pack"-function.
  156.  
  157. Undeleting files:
  158. With "Undelete" you can remove the flag, that marks a file as deleted.
  159. This is only possible, if the file has not been physically removed.
  160.  
  161. Setting filenotes:
  162. "Filenote" enables you to set/remove filenotes. Removing a filenote is done
  163. by deleting the string from the stringgadget of the requester that asks you
  164. for the new filenote.
  165.  
  166. Changing the fileprotection:
  167. "Protect" will open a requester for any selected file and enables you to
  168. enter the new protectionflags via some buttons.
  169.  
  170. Packing archives:
  171. "Pack" will remove all files that have been marked as deleted and removes
  172. some information, that has been added for the renaming of files and setting
  173. of filenotes. After you have packed an archive it is no longer possible to
  174. recover deleted files from an archive.
  175.  
  176. "Options" allows you to select a new packer-sublibrary and mode and allows
  177. you to enter the password if you have selected an encryptionlibrary.
  178.  
  179. "Parent" gets the parent-directory of the sourcedirectory.
  180.  
  181. "Get" rereads the contents of the sourcedirectory.
  182.  
  183. "Direct-CMD" is used to send a commandline direct to the archive sublibrary.
  184. See the archive-sublibrary for more information.
  185.  
  186. The listview below the "Get" gadget allows you to select a new volume for
  187. the sourcedirectory.
  188.  
  189. Other Gadgets:
  190. The scrollers are used to, hmm, scroll around :-)
  191.  
  192. "Sync"-Gadget:
  193. This one is a useful thing. If activated changes to the path either by
  194. double-clicking on a directory or via the "parent"-gadget are applied to
  195. both paths. This allows the easy duplication of complete directorytrees.
  196.  
  197.  
  198. Menus:
  199. ------
  200.  
  201. Project
  202.    Quit:        quit XArcTool
  203.  
  204. Specials:
  205.    Tag all:     mark all files within the sourcedirectory as selected
  206.    Tag Pattern: mark all files that match a pattern in the sourcedirectory
  207.                 as selected
  208.  
  209.    Untag all
  210.    Untag Pattern : Like the "Tag" functions, just that they mark the files
  211.                    as deselected.
  212.  
  213.  
  214.  
  215.                            What XArcTool displays
  216.                            ----------------------
  217. XArcTool displays the following information in its directorylists:
  218.  
  219. For normal directories (in this order):
  220. filename filesize protectionflags date&time filenote
  221.  
  222. For archives:
  223. filename generationnumber (compressed size) uncompressed size packer
  224.                   protectionflags date&time filenote
  225.  
  226.  
  227.  
  228.  
  229.                                Generations
  230.                                -----------
  231. xpkarchive.library is able to keep more than one version of every file (like
  232. e.g. zoo). These files have exact the same filename, but they differ in the
  233. generationnumber. xpkarchive.library tries to keep track of the
  234. versionnumber, e.g. if you add a file, that already exists in the archive,
  235. the file will get the next higher generationnumber.
  236. Generationnumber 0 is a special generationnumber and references always the
  237. file with the filename and the highest generationnumber, normally this is
  238. the newest file with a given filename.
  239.  
  240.  
  241.                                 History
  242.                                 -------
  243. 2.0: support for the xpkarchive.library V2.0, that supports
  244.      archive-sublibraries
  245.  
  246. 1.4: used SetWindowPointer under V37, which exists only since V39, fixed
  247.  
  248. 1.3: first public release
  249.  
  250.  
  251.  
  252. TODO:
  253.  
  254. Write a better documentation :-)
  255.  
  256.  
  257. If you find bugs, have questions or ??? write to:
  258.  
  259.    Matthias Meixner
  260.    Sandberg 13
  261.    36145 Schwarzbach
  262.    Germay
  263.  
  264. EMail:
  265.    meixner@rbg.informatik.th-darmstadt.de
  266.  
  267.  
  268.  
  269.